DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

A.7.2.0 StructureDefinition: USLab-ObsCode

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/uslab-obscode

US Realm laboratory result using CodeableConcept Data Type for non-numeric results

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.7.2.0.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Observation.

Summary

Mandatory: 12 elements (+9 nested mandatory elements)
Must-Support: 35 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of type@profile (ordered, Open at End)

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Realm laboratory result using CodeableConcept Data Type for non-numeric results
... identifier S1..*Identifier
.... use S1..1code
.... system S1..1uri
.... value S1..1string
... status S1..1code
... code S1..1CodeableConceptUS Realm Laboratory Test Name
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
..... display S0..1string
.... text S0..1stringDisplay text
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)
... effective[x] S I0..1dateTime, Periodinv-1: Datetime must be at least to day.
... issued S I0..1instantinv-4: Datetime must be at least to day.
... performer SReference(US Laboratory Organization Profile)Slice: Ordered, Open At End, by type@profile
... valueCodeableConcept S0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodUS Realm Coded Test Result
Binding: SNOMED CT Codes (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... dataAbsentReason S0..1CodeableConcept
... interpretation S0..1CodeableConceptBinding: US Laboratory Observation Profile Interpretation Codes (required)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
... bodySite 0..0
... specimen S0..1Reference(US Laboratory Specimen Profile)
... related 0..0
... uslab-specimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason
Slice: Unordered, Open, by url
... uslab-observationkind S1..1codeKind of observation
URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Realm laboratory result using CodeableConcept Data Type for non-numeric results
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslab-specimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: US Laboratory Observation Specimen Rejection Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑0..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringPlain text representation of the concept
... uslab-observationkind S1..1codeKind of observation
URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptUS Realm Laboratory Test Name
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display S ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S ∑0..1stringDisplay text
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] S ∑I0..1dateTime, PeriodClinically relevant time/time-period for observation
inv-1: Datetime must be at least to day.
... issued S ∑I0..1instantDate/Time this was made available
inv-4: Datetime must be at least to day.
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Open At End, by type@profile
... performer S ∑1..1Reference(US Laboratory Organization Profile)Who is responsible for the observation
... value[x] S ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodUS Realm Coded Test Result
Binding: SNOMED CT Codes (extensible)
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: US Laboratory Observation Profile Interpretation Codes (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen S0..1Reference(US Laboratory Specimen Profile)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Observation.

Summary

Mandatory: 12 elements (+9 nested mandatory elements)
Must-Support: 35 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of type@profile (ordered, Open at End)

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationUS Realm laboratory result using CodeableConcept Data Type for non-numeric results
... identifier S1..*Identifier
.... use S1..1code
.... system S1..1uri
.... value S1..1string
... status S1..1code
... code S1..1CodeableConceptUS Realm Laboratory Test Name
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
..... display S0..1string
.... text S0..1stringDisplay text
... subject S1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)
... effective[x] S I0..1dateTime, Periodinv-1: Datetime must be at least to day.
... issued S I0..1instantinv-4: Datetime must be at least to day.
... performer SReference(US Laboratory Organization Profile)Slice: Ordered, Open At End, by type@profile
... valueCodeableConcept S0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodUS Realm Coded Test Result
Binding: SNOMED CT Codes (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... dataAbsentReason S0..1CodeableConcept
... interpretation S0..1CodeableConceptBinding: US Laboratory Observation Profile Interpretation Codes (required)
.... coding S1..*Coding
..... system S1..1uri
..... code S1..1code
... bodySite 0..0
... specimen S0..1Reference(US Laboratory Specimen Profile)
... related 0..0
... uslab-specimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason
Slice: Unordered, Open, by url
... uslab-observationkind S1..1codeKind of observation
URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationUS Realm laboratory result using CodeableConcept Data Type for non-numeric results
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... uslab-specimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
URL: http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/uslab-specimenrejectreason"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: US Laboratory Observation Specimen Rejection Codes (extensible)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑0..*CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text S ∑0..1stringPlain text representation of the concept
... uslab-observationkind S1..1codeKind of observation
URL: http://hl7.org/fhir/StructureDefinition/uslab-observationkind
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptUS Realm Laboratory Test Name
Binding: US Laboratory Observation Profile Observation Name Codes (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display S ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text S ∑0..1stringDisplay text
... subject S ∑1..1Reference(US Laboratory Patient Profile | US Laboratory Patient Profile)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] S ∑I0..1dateTime, PeriodClinically relevant time/time-period for observation
inv-1: Datetime must be at least to day.
... issued S ∑I0..1instantDate/Time this was made available
inv-4: Datetime must be at least to day.
... performer ∑Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
Slice: Ordered, Open At End, by type@profile
... performer S ∑1..1Reference(US Laboratory Organization Profile)Who is responsible for the observation
... value[x] S ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodUS Realm Coded Test Result
Binding: SNOMED CT Codes (extensible)
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: US Laboratory Observation Profile Interpretation Codes (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S ∑1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S ∑1..1uriIdentity of the terminology system
..... version ∑0..1stringVersion of the system - if relevant
..... code S ∑1..1codeSymbol in syntax defined by the system
..... display ∑0..1stringRepresentation defined by the system
..... userSelected ∑0..1booleanIf this coding was chosen directly by the user
.... text ∑0..1stringPlain text representation of the concept
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen S0..1Reference(US Laboratory Specimen Profile)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.7.2.0.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.extension.valueCodeableConceptUS Laboratory Observation Specimen Rejection CodesextensibleUS Laboratory Observation Specimen Rejection Codes
Observation.identifier.useIdentifierUserequiredIdentifierUse
Observation.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeUS Laboratory Observation Profile Observation Name CodesextensibleUS Laboratory Observation Profile Observation Name Codes
Observation.value[x]SNOMED CT CodesextensibleSNOMED CT Codes
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationUS Laboratory Observation Profile Interpretation CodesrequiredUS Laboratory Observation Profile Interpretation Codes
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

A.7.2.0.3 Constraints

IdPathDetailsRequirements
obs-6ObservationSHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
inv-1Observation.effective[x]Datetime must be at least to day.
XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
inv-4Observation.issuedDatetime must be at least to day.
XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.